Cleaned up notes about documentation blacklisting
authorVignesh Sankaran <developer@sankaran.io>
Thu, 27 Jul 2017 05:02:16 +0000 (15:02 +1000)
committerVignesh Sankaran <developer@sankaran.io>
Thu, 27 Jul 2017 05:06:53 +0000 (15:06 +1000)
src/doc/manifest.md

index 8fd2d6c375939b1da0fbd4caf9474cc2c4eafc4c..5adf17275ce2358ad48f1c128c8189a966d7746c 100644 (file)
@@ -48,10 +48,14 @@ This field specifies a URL to a website hosting the crate's documentation.
 If no URL is specified in the manifest file, [crates.io][cratesio] will
 automatically link your crate to the corresponding [docs.rs][docsrs] page.
 
-Documentation links from specific domainss are blacklisted. Currently, any link
-from rust-ci.org will be blacklisted since this domain is no longer used for
-legitimate documentation hosting. URLs from this domain will have no reported
-documentation link on crates.io.
+Documentation links from specific hosts are blacklisted. Hosts are added 
+to the blacklist if they are known to not be hosting documentation and are 
+possibly of malicious intent e.g. ad tracking networks. URLs from the 
+following hosts are blacklisted:
+- rust-ci.org
+
+Documentation URLs from blacklisted hosts will not appear on crates.io, and
+may be replaced by docs.rs links.
 
 [docsrs]: https://docs.rs/
 [cratesio]: https://crates.io/